# Python 注释

# 注释是用来解释代码的，可以帮助开发者更好的理解代码。
# 注释不会被执行，可以用作提醒、说明、临时代码、调试等。
# 注释的作用：
# 1. 提高代码可读性
# 2. 方便其他程序员阅读代码
# 3. 方便自己以后查看自己代码时，快速理解代码的用途

# 注释最佳实践：
# 1. 解释为什么这么做
# 2. 关键算法添加注释说明
# 3. 修改代码同步更新注释

# 单行注释

# 计算园的面积
radius = 5
area = 3.14 * radius ** 2 # 圆的面积公式 v = πr²
print("圆的面积:", area)


# 多行注释
# 多行注释使用三个双引号或者单引号括起来的内容，可以跨越多行。
"""
作者：风清影竹
日期：2021-05-10
功能：计算圆的面积
参数：
    radius: 半径
返回值：    
    area: 圆的面积
"""

'''
作者：风清影竹
日期：2021-05-10
功能：计算bmi指数
参数：
    weight: 体重
    height: 身高
返回值：    
    bmi: bmi指数
'''
def calc_bmi(weight, height):
    # height ** 2 计算身高的平方, 等同于 height * height
    return weight / (height ** 2)
# 这里打印使用了 + 号连接字符串和变量，而calc_bmi()函数的返回值是浮点数，需要用str() 函数用于将数字转换为字符串
print("bim指数:" + str(calc_bmi(130, 172)))


# 行与缩进
# Python 代码块由缩进来定义，缩进的空格数是可变的，但同一个代码块的语句必须包含相同的缩进空格数。
# 行与缩进的作用：
# 1. 代码结构清晰
# 2. 方便代码阅读和维护
# 3. 避免语法错误

# 错误的缩进
# 以下代码中，if 语句的缩进错误，导致代码无法执行。
#if True:
#print("Hello, world!")

# 正确的缩进
# 以下代码中，if 语句的缩进正确，代码可以正常执行。
if True:
    print("Hello, world!")


# 错误的缩进
# 以下代码中，for 循环的缩进错误，导致代码无法执行。
#for i in range(10):
#print(i)

# 正确的缩进
# 以下代码中，for 循环的缩进正确，代码可以正常执行。
for i in range(10):
    print(i)


# 错误的缩进
# 以下代码中，while 循环的缩进错误，导致代码无法执行。
#while i < 10:
#print(i)

# 正确的缩进
# 以下代码中，while 循环的缩进正确，代码可以正常执行。
i = 0
while i < 10:
    print(i)
    i = i + 1


# 错误的缩进
# 以下代码中，函数定义的缩进错误，导致代码无法执行。
#def my_func():
#print("Hello, world!")

# 正确的缩进
# 以下代码中，函数定义的缩进正确，代码可以正常执行。
def my_func():
    print("Hello, world!")